Skip to content

docs: add GitHub issue links to FAQ sections and improve support section in README - #130

Merged
lennardrother merged 11 commits into
SAP:mainfrom
sk31337:docs/faq-issue-links
Jul 21, 2026
Merged

docs: add GitHub issue links to FAQ sections and improve support section in README#130
lennardrother merged 11 commits into
SAP:mainfrom
sk31337:docs/faq-issue-links

Conversation

@sk31337

@sk31337 sk31337 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • FAQ sections updated in all end-user-guide docs: replaced the generic "Reach out to us" placeholder with a direct link to open a GitHub issue and a reference to the 👐 Support, Feedback section in the README.

    • docs/end-user-guides/instance-mapping.mdx — existing empty FAQ updated
    • docs/end-user-guides/setup.mdx — FAQ section added at end of file
    • docs/end-user-guides/schema.mdx — FAQ section added at end of file
    • docs/end-user-guides/users.mdx — FAQ section added at end of file
    • docs/end-user-guides/table.mdx — FAQ section added at end of file (after the closing </Tabs>)
  • README.md support section split into two dedicated sections:

    • New ## 👐 Support, Feedback section with the GitHub issues link and a Slack channel reference (#crossplane-provider-sap)
    • New ## Contributing section with the existing contribution guidelines link

Motivation

The FAQ sections previously had a generic call-to-action with no actionable link. Users now have a direct path to open a GitHub issue, and the README has a clearly anchored support section that the FAQ links can point to (#-support-feedback).

@sk31337
sk31337 marked this pull request as ready for review July 9, 2026 11:22
@sk31337
sk31337 requested a review from a team July 9, 2026 11:22
Comment thread README.md
@sk31337
sk31337 deployed to pr-e2e-approval July 21, 2026 09:59 — with GitHub Actions Active
@lennardrother
lennardrother merged commit a821b32 into SAP:main Jul 21, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants